Welcome to Glitchy Games!
Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
Reference
Modules
Glitchygames plugin API.
Color constants and palette helpers.
This module contains color constants and palette helpers.
Attributes
module-attribute
NES = 'nes'
module-attribute
SYSTEM = 'system'
module-attribute
VGA = 'vga'
module-attribute
__all__ = ['NES', 'SYSTEM', 'VGA', 'Default']
module-attribute
YELLOW = YELLOW
module-attribute
PURPLE = PURPLE
module-attribute
BLUE = BLUE
module-attribute
GREEN = GREEN
module-attribute
WHITE = WHITE
module-attribute
BLACK = BLACK
module-attribute
BLACKLUCENT = BLACKLUCENT
module-attribute
BLUELUCENT = BLUELUCENT
module-attribute
RED = RED
Classes
Bases: ColorPalette
A default set of colors used for Glitchy Games Examples.
instance-attribute
YELLOW = get_color(0)
instance-attribute
PURPLE = get_color(1)
instance-attribute
BLUE = get_color(2)
instance-attribute
GREEN = get_color(3)
instance-attribute
WHITE = get_color(4)
instance-attribute
BLACK = get_color(5)
instance-attribute
BLACKLUCENT = get_color(6)
instance-attribute
BLUELUCENT = get_color(7)
instance-attribute
RED = get_color(8)
get_color(palette_index: int) -> tuple[int, int, int]
Returns PyGame Color from the palette at the specified index.
| Parameters: |
|
|---|
| Returns: |
|
|---|
set_color(palette_index: int, new_color: tuple) -> None
Sets the indexed color to the new PyGame Color.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__() -> None
Create a default color palette object.
| Returns: |
|
|---|
Modules
GlitchyGames palette module.
palette: Manages the custom color palette file format used by the engine.
module-attribute
VGA = 'vga'
module-attribute
SYSTEM = 'system'
module-attribute
NES = 'nes'
Manages color palette data for Glitchy Games.
__init__(colors: Optional(list | None) = None, filename: Optional(str, None) = None) -> None
Create a color palette object.
| Parameters: |
|
|---|
get_color(palette_index: int) -> tuple[int, int, int]
Returns PyGame Color from the palette at the specified index.
| Parameters: |
|
|---|
| Returns: |
|
|---|
set_color(palette_index: int, new_color: tuple) -> None
Sets the indexed color to the new PyGame Color.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Utility class for working with Glitchy Games palettes.
staticmethod
load_palette_from_config(config: dict) -> list
Load a palette from a ConfigParser object.
| Parameters: |
|
|---|
| Returns: |
|
|---|
staticmethod
load_palette_from_file(config_file_path: str) -> list
Load a palette from a GlitchyGames palette file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
staticmethod
write_palette_to_file(config_data: dict, output_file: str) -> None
Write a GlitchyGames palette to a file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
staticmethod
parse_rgb_data_in_file(rgb_data_file: str) -> list
Read RGB data from a file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
staticmethod
create_palette_data(colors: list) -> ConfigParser
Create a ConfigParser object containing palette data from a list of PyGame Colors.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: ColorPalette
A default set of colors used for Glitchy Games Examples.
instance-attribute
YELLOW = get_color(0)
instance-attribute
PURPLE = get_color(1)
instance-attribute
BLUE = get_color(2)
instance-attribute
GREEN = get_color(3)
instance-attribute
WHITE = get_color(4)
instance-attribute
BLACK = get_color(5)
instance-attribute
BLACKLUCENT = get_color(6)
instance-attribute
BLUELUCENT = get_color(7)
instance-attribute
RED = get_color(8)
get_color(palette_index: int) -> tuple[int, int, int]
Returns PyGame Color from the palette at the specified index.
| Parameters: |
|
|---|
| Returns: |
|
|---|
set_color(palette_index: int, new_color: tuple) -> None
Sets the indexed color to the new PyGame Color.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__() -> None
Create a default color palette object.
| Returns: |
|
|---|
Bases: ColorPalette
A palette representing the 16 default system colors.
instance-attribute
BLACK = get_color(0)
instance-attribute
MAROON = get_color(1)
instance-attribute
GREEN = get_color(2)
instance-attribute
OLIVE = get_color(3)
instance-attribute
NAVY = get_color(4)
instance-attribute
PURPLE = get_color(5)
instance-attribute
TEAL = get_color(6)
instance-attribute
SILVER = get_color(7)
instance-attribute
GREY = get_color(8)
instance-attribute
RED = get_color(9)
instance-attribute
LIME = get_color(10)
instance-attribute
YELLOW = get_color(11)
instance-attribute
BLUE = get_color(12)
instance-attribute
MAGENTA = get_color(13)
instance-attribute
CYAN = get_color(14)
instance-attribute
WHITE = get_color(15)
get_color(palette_index: int) -> tuple[int, int, int]
Returns PyGame Color from the palette at the specified index.
| Parameters: |
|
|---|
| Returns: |
|
|---|
set_color(palette_index: int, new_color: tuple) -> None
Sets the indexed color to the new PyGame Color.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__() -> None
Create a system color palette object.
| Returns: |
|
|---|
Bases: ColorPalette
The 256 VGA color palette.
get_color(palette_index: int) -> tuple[int, int, int]
Returns PyGame Color from the palette at the specified index.
| Parameters: |
|
|---|
| Returns: |
|
|---|
set_color(palette_index: int, new_color: tuple) -> None
Sets the indexed color to the new PyGame Color.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__() -> None
Create a VGA color palette object.
| Returns: |
|
|---|
Contains GameEngine and helper classes for building a game.
Attributes
module-attribute
LOG: Logger = getLogger('game.engine')
module-attribute
PACKAGE_PATH: str = parent
module-attribute
ASSET_PATH: str = parent / 'assets'
module-attribute
TEST_MODE = False
Classes
Bases: ResourceManager
Game event manager.
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
Bases: ResourceManager
Game event proxy.
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
game: object = get('game')
instance-attribute
proxies = [game]
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(**kwargs) -> None
Initialize the game proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle fps event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_game_event(event: Event) -> None
Handle game event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_menu_item_event(event: Event) -> None
Handle menu item event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object = None) -> None
Initialize the game event manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> ArgumentParser
Add arguments to the argument parser.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventManager
Glitchy Games' Game engine.
The game engine is responsible for initializing pygame and handling events. It also provides a number of helper methods for common tasks such as setting the screen resolution and setting the cursor.
Every Glitchy Game game inherits the GameEngine command line options, so you can add your own command line options by implementing the args() class method in your Scene class.
class-attribute
instance-attribute
__instances__: ClassVar = {}
class-attribute
instance-attribute
game: object = None
class-attribute
instance-attribute
icon: Surface = load(Path(ASSET_PATH) / 'glitch.png')
class-attribute
instance-attribute
NAME: Literal['Boilerplate Adventures'] = 'Boilerplate Adventures'
class-attribute
instance-attribute
VERSION: Literal['1.0'] = '1.0'
class-attribute
instance-attribute
OPTIONS: ClassVar = None
class-attribute
instance-attribute
LAST_EVENT_MISS: ClassVar = None
class-attribute
instance-attribute
MISSING_EVENTS: ClassVar = []
class-attribute
instance-attribute
UNIMPLEMENTED_EVENTS: ClassVar = []
class-attribute
instance-attribute
USE_FASTEVENTS: ClassVar = False
class-attribute
instance-attribute
EVENT_HANDLERS: ClassVar = {}
instance-attribute
fps: float = get('fps', 0.0)
instance-attribute
update_type = get('update_type')
instance-attribute
use_gfxdraw = get('use_gfxdraw')
instance-attribute
windowed = get('windowed')
instance-attribute
fps_refresh_rate = get('fps_refresh_rate')
instance-attribute
pygame_version = {'major': 0, 'minor': 0, 'patch': 0}
instance-attribute
scene_manager: SceneManager = SceneManager()
instance-attribute
mode_flags: int = 0
instance-attribute
desired_resolution: tuple[int, int] = suggested_resolution(desired_width, desired_height)
property
screen_width: int
Get the screen width.
| Returns: |
|
|---|
property
screen_height: int
Get the screen height.
| Returns: |
|
|---|
Proxy for events.
instance-attribute
proxies = []
instance-attribute
event_source = event_source
__init__(event_source: object) -> None
Initialize the event proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
unhandled_event(*args, **kwargs) -> None
Handle unhandled events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object, icon: Surface | Path | str = None) -> None
Initialize the game engine.
| Parameters: |
|
|---|
| Returns: |
|
|---|
initialize_display() -> None
Initialize the display.
| Returns: |
|
|---|
initialize_event_handlers() -> None
Initialize event handlers.
The engine calls this on your behalf.
Event subsystem bootstrapping
This gives us much faster event processing than doing a lookup every time an event comes in since we can just call the processing function directly.
It's not as fast as a raw pygame event loop, but since we layer richer event types on top of the pygame raw events, this gives us a nice balance of extensibility with performance.
| Returns: |
|
|---|
initialize_input_event_handlers() -> None
Initialize input event handlers.
The engine calls this on your behalf.
This initializes the input event handlers.
| Returns: |
|
|---|
__del__() -> None
Delete the game engine.
| Returns: |
|
|---|
print_system_info() -> None
Print system information.
| Returns: |
|
|---|
print_game_info() -> None
Print game information.
| Returns: |
|
|---|
suggested_resolution(desired_width: int = 0, desired_height: int = 0) -> tuple[int, int]
Suggest a resolution.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
set_cursor(
cursor: list[str], cursor_black: str = ".", cursor_white: str = "X", cursor_xor: str = "o"
) -> list[str]
Set the cursor.
| Parameters: |
|
|---|
| Returns: |
|
|---|
initialize_system_icons() -> None
Initialize system icons.
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> ArgumentParser
Add Glitchy Games arguments to the argument parser.
All Glitchy Games will inherit these arguments.
Supported Arguments
-f, --target-fps --fps-refresh-rate -w, --windowed -r, --resolution --use-gfxdraw --update-type --video-driver
| Parameters: |
|
|---|
| Returns: |
|
|---|
start() -> None
Start the game engine.
| Returns: |
|
|---|
classmethod
quit_game() -> None
Quit the game.
Emits a pygame.event.Event(pygame.QUIT, {}) event.
| Returns: |
|
|---|
process_events() -> bool
Process events.
| Returns: |
|
|---|
process_audio_event(event: Event) -> bool
Process an audio event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_controller_event(event: Event) -> bool
Process a controller event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_drop_event(event: Event) -> bool
Process a drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_touch_event(event: Event) -> bool
Process a touch event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_midi_event(event: Event) -> bool
Process a midi event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_mouse_event(event: Event) -> bool
Process a mouse event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_keyboard_event(event: Event) -> bool
Process a keyboard event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_joystick_event(event: Event) -> bool
Process a joystick event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_text_event(event: Event) -> None
Process a text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_window_focus_event(event: Event) -> bool
Process a window focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_window_event(event: Event) -> None
Process a window event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_game_event(event: Event) -> None
Process a game event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
process_unimplemented_event(event: Event) -> None
Process an unimplemented event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
post_game_event(event_subtype: EventType, event_data: dict) -> None
Post a game event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
suppress_event(*args, attr: str, **kwargs) -> None
Suppress an event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
register_game_event(event_type: EventType, callback: Callable) -> None
Register a game event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
missing_event(*args, **kwargs) -> None
Suppress unhandled on_*_event methods.
We only want to log this once per event type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__getattr__(attr: str) -> Callable
Suppress unhandled on_*_event methods.
If the attribute being looked up is not an on_*_event attribute, raise AttributeError as usual.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Modules
Glitchy Games event module.
This module contains the event substrate for handling higher level events in the game engine.
Many events are 1:1 with pygame events, but some are synthesized. For example, a mouse drop event is a synthesized event that is triggered by a mouse button down event followed by a mouse motion event followed by a mouse button up event.
Attributes
module-attribute
LOG: Logger = getLogger('game.events')
module-attribute
FPSEVENT = USEREVENT + 1
module-attribute
GAMEEVENT = USEREVENT + 2
module-attribute
MENUEVENT = USEREVENT + 3
module-attribute
CONTROLLER_EVENTS = supported_events(like='CONTROLLER.*?')
module-attribute
TOUCH_EVENTS = supported_events(like='(FINGER|MULTI).*?')
module-attribute
JOYSTICK_EVENTS = supported_events(like='JOY.*?')
module-attribute
KEYBOARD_EVENTS = supported_events(like='KEY.*?')
module-attribute
WINDOW_EVENTS = supported_events(like='WINDOW.*?')
module-attribute
GAME_EVENTS = list(
set(ALL_EVENTS)
- set(AUDIO_EVENTS)
- set(CONTROLLER_EVENTS)
- set(DROP_EVENTS)
- set(TOUCH_EVENTS)
- set(JOYSTICK_EVENTS)
- set(KEYBOARD_EVENTS)
- set(MIDI_EVENTS)
- set(MOUSE_EVENTS)
- set(TEXT_EVENTS)
- set(WINDOW_EVENTS)
)
Classes
Singleton aggregator base class for event proxies.
A ResourceManager subclass will generally pass all requests through to its proxy object(s), however, for certain types of resources such as joysticks, the subclass will manage things itself. This architecture reduces code footprint, and allows maxium flexibility when needed, at the expense of a bit of abstraction.
Unless you're implementing a new pygame event manager, you probably don't need to worry about this.
Any subclass of ResourceManager will become a singleton class automatically. This ensures that there is only ever a single manager for any given resource.
For instance, a second instantiation of MouseManager would return the same MouseManager object that the GameEngine created to process mouse events with.
This behavior allows easy access to resource managers anywhere in the game without needing an explicit copy of the game object, althogh since GameEngine is also a subclass of EventManager, it too is a ResourceManager which can be gotten to from anywhere, since it's a singleton.
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
proxies = []
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object) -> None
Initialize the resource manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
Bases: dict
instance-attribute
__hash = hash((type, tuple(keys())))
property
dict
__init__(type, *args, **attributes)
__setitem__(key, item)
__getitem__(key)
__len__()
__delitem__(key)
clear()
copy()
has_key(k)
update(*args, **kwargs)
keys()
values()
__hash__()
__eq__(other)
__ne__(other)
__repr__()
__str__()
__copy__()
__deepcopy__(memo)
__reduce__()
__setstate__(state)
Abstract base class for event interfaces.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
Bases: EventInterface
Mixin for audio events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: AudioEvents
Mixin for audio events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for controller events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: ControllerEvents
Mixin for controller events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for drop events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for drop events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for touch events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_touch_down_event(event: Event) -> None
Handle finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_touch_motion_event(event: Event) -> None
Handle finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_touch_up_event(event: Event) -> None
Handle finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for touch events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_touch_down_event(event: Event) -> None
Handle finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_touch_motion_event(event: Event) -> None
Handle finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_touch_up_event(event: Event) -> None
Handle finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for glitchy game events.
This includes built-ins like QUIT, and synthesized events like FPS and GAME events.
It's sort of a catch-all for event types that didn't have a good home otherwise.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for glitchy game events.
This includes built-ins like QUIT, and synthesized events like FPS and GAME events.
It's sort of a catch-all for event types that didn't have a good home otherwise.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for font events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for font events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for keyboard events.
Bases: EventInterface
Mixin for keyboard events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_key_down_event(event: Event) -> None
Handle key down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_up_event(event: Event) -> None
Handle key up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for joystick events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_joy_button_down_event(event: Event) -> None
Handle joystick button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_joy_button_up_event(event: Event) -> None
Handle joystick button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for joystick events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_button_down_event(event: Event) -> None
Handle joystick button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_button_up_event(event: Event) -> None
Handle joystick button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for midi events.
Bases: EventInterface
Mixin for midi events.
Bases: EventInterface
Mixin for mouse events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_button_up_event(event: Event) -> None
Handle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for mouse events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_up_event(event: Event) -> None
Handle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for text events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for text events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for window events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: EventInterface
Mixin for window events.
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: AudioEvents, ControllerEvents, DropEvents, TouchEvents, FontEvents, GameEvents, JoystickEvents, KeyboardEvents, MidiEvents, MouseEvents, TextEvents, WindowEvents
Mixin for all events.
Bases: AudioEventStubs, ControllerEventStubs, DropEventStubs, TouchEventStubs, FontEventStubs, GameEventStubs, JoystickEventStubs, KeyboardEventStubs, MidiEventStubs, MouseEventStubs, TextEventStubs, WindowEventStubs
Mixin for all event stubs.
Bases: ResourceManager
Root event manager.
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
proxies = [EventProxy(event_source=self)]
Proxy for events.
class-attribute
instance-attribute
log: Logger = LOG
instance-attribute
proxies = []
instance-attribute
event_source = event_source
__init__(event_source: object) -> None
Initialize the event proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
unhandled_event(*args, **kwargs) -> None
Handle unhandled events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object = None) -> None
Initialize the event manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Functions
supported_events(like: str = '.*') -> list
Return a list of supported events.
This method is crucial for allowing the game engine to support both older versions of pygame and newer versions. It allows us to enumerate supported pygame events and initialize them dynamically.
This ensures that the game engine will work with many versions of pygame.
We enumerate all pygame event IDs and then use the pygame.event.event_name() method to get the event name. We then use a regular expression to match the event name against the like parameter.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dump_cache_info(func, *args, **kwargs)
cached
unhandled_event(game, event, *args, **kwargs) -> NoReturn
Handle unhandled events.
This method is called when an event is not handled by any of the event handlers.
This is helpful for us to debug events that we haven't implemented yet.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
Modules
Audio.
This is a simple audio manager that can be used to manage audio.
module-attribute
log = getLogger('game.audio')
Bases: ResourceManager
Manage pygame audio events.
class-attribute
instance-attribute
__instances__: ClassVar = {}
Bases: AudioEvents, ResourceManager
Pygame audio event proxy.
class-attribute
instance-attribute
log: Logger = LOG
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
proxies = [game, mixer]
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
__init__(game: object = None) -> None
Initialize the audio proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_audio_device_added_event(event: Event) -> None
Handle audio device added event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object = None) -> None
Initialize the audio manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> ArgumentParser
Add arguments to the argument parser.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Controller Events.
This is a simple controller event class that can be used to handle controller events.
module-attribute
LOG: Logger = getLogger('game.controllers')
Bases: ControllerEvents, ResourceManager
Manage controller events.
class-attribute
instance-attribute
__instances__: ClassVar = {}
class-attribute
instance-attribute
log: Logger = LOG
instance-attribute
controllers = {}
instance-attribute
proxies = [game]
Bases: ControllerEvents, ResourceManager
Proxy class for controller events.
class-attribute
instance-attribute
__instances__: ClassVar = {}
class-attribute
instance-attribute
log: Logger = LOG
class-attribute
instance-attribute
AXIS: ClassVar = [
CONTROLLER_AXIS_LEFTX,
CONTROLLER_AXIS_LEFTY,
CONTROLLER_AXIS_RIGHTX,
CONTROLLER_AXIS_RIGHTY,
CONTROLLER_AXIS_TRIGGERLEFT,
CONTROLLER_AXIS_TRIGGERRIGHT,
]
class-attribute
instance-attribute
BUTTONS: ClassVar = [
CONTROLLER_BUTTON_A,
CONTROLLER_BUTTON_B,
CONTROLLER_BUTTON_X,
CONTROLLER_BUTTON_Y,
CONTROLLER_BUTTON_DPAD_UP,
CONTROLLER_BUTTON_DPAD_DOWN,
CONTROLLER_BUTTON_DPAD_LEFT,
CONTROLLER_BUTTON_DPAD_RIGHT,
CONTROLLER_BUTTON_LEFTSHOULDER,
CONTROLLER_BUTTON_RIGHTSHOULDER,
CONTROLLER_BUTTON_LEFTSTICK,
CONTROLLER_BUTTON_RIGHTSTICK,
CONTROLLER_BUTTON_BACK,
CONTROLLER_BUTTON_GUIDE,
CONTROLLER_BUTTON_START,
]
instance-attribute
controller = Controller(_id)
instance-attribute
game = game
instance-attribute
proxies = [game, controller]
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
__init__(game: object = None, controller_id: int = -1) -> None
Initialize the controller proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> LiteralString
Return a string representation of the controller.
| Returns: |
|
|---|
__repr__() -> str
Return a string representation of the controller object.
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
__init__(game: object = None) -> None
Initialize the ControllerManager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> ArgumentParser
Add controller options to the parser.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Drop Events.
This is a simple drop event class that can be used to handle drag & drop events.
module-attribute
log = getLogger('game.events.drop_events')
Bases: ResourceManager
Manage drop events.
class-attribute
instance-attribute
__instances__: ClassVar = {}
Bases: DropEvents, ResourceManager
Proxy class for drop events.
class-attribute
instance-attribute
log: Logger = LOG
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
proxies = [game]
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
__init__(game: object = None) -> None
Initialize the drop proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object = None) -> None
Initialize the drop manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> ArgumentParser
Add arguments to the argument parser.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Joystick Event Manager.
module-attribute
LOG = getLogger('game.joysticks')
Bases: JoystickEvents, ResourceManager
Manage joystick events.
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
joysticks = {}
instance-attribute
proxies = [game]
Bases: JoystickEvents, ResourceManager
Joystick event proxy.
class-attribute
instance-attribute
__instances__: ClassVar = {}
class-attribute
instance-attribute
log = LOG
instance-attribute
joystick = Joystick(_id)
instance-attribute
proxies = [game, joystick]
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
__init__(game: object = None, joystick_id: int = -1) -> None
Initialize the joystick event proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joystick button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joystick button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
get_name() -> str
Get the joystick name.
| Returns: |
|
|---|
get_init() -> bool
Get the joystick init status.
| Returns: |
|
|---|
get_numaxes() -> int
Get the number of axes.
| Returns: |
|
|---|
get_numballs() -> int
Get the number of trackballs.
| Returns: |
|
|---|
get_numbuttons() -> int
Get the number of buttons.
| Returns: |
|
|---|
get_numhats() -> int
Get the number of hats.
| Returns: |
|
|---|
__str__() -> str
Get the joystick info.
| Returns: |
|
|---|
__repr__() -> str
Get the joystick representation.
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
__init__(game: object = None) -> None
Initialize the joystick event manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> ArgumentParser
Add joystick-specific arguments to the global parser.
This class method will get called automatically by the GameEngine class.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joystick button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joystick button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Keyboard Event Manager.
module-attribute
log = getLogger('game.keyboard')
Bases: ResourceManager
Manage keyboard events.
class-attribute
instance-attribute
log: Logger = LOG
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
proxies = [KeyboardProxy(game=game)]
Bases: KeyboardEvents, ResourceManager
Keyboard event proxy.
class-attribute
instance-attribute
log: Logger = LOG
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
keys = {}
instance-attribute
proxies = [game, key]
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
__init__(game: object = None) -> None
Initialize the keyboard event proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle key down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle key up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object = None) -> None
Initialize the keyboard event manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> ArgumentParser
Add keyboard-specific arguments to the global parser.
This class method will get called automatically by the GameEngine class.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Midi Event Manager.
module-attribute
log = getLogger('game.midi')
Bases: ResourceManager
Manage midi events.
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
proxies = []
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object = None) -> None
Initialize the midi event manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> ArgumentParser
Add midi-specific arguments to the global parser.
This class method will get called automatically by the GameEngine class.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Mouse manager.
module-attribute
LOG = getLogger('game.mouse')
module-attribute
MOUSE_BUTTON_LEFT = 1
module-attribute
MOUSE_BUTTON_WHEEL = 2
module-attribute
MOUSE_BUTTON_RIGHT = 3
module-attribute
MOUSE_WHEEL_SCROLL_UP = 4
module-attribute
MOUSE_WHEEL_SCROLL_DOWN = 5
Bases: ResourceManager
Mouse manager event handler.
class-attribute
instance-attribute
__instances__: ClassVar = {}
Bases: MouseEvents, ResourceManager
Mouse manager event proxy.
class-attribute
instance-attribute
log: Logger = LOG
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
mouse_state = {}
instance-attribute
mouse_dragging = False
instance-attribute
mouse_dropping = False
instance-attribute
current_focus = None
instance-attribute
previous_focus = None
instance-attribute
focus_locked = False
instance-attribute
proxies = [game, mouse]
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
__init__(game: object = None) -> None
Initialize the mouse manager event proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_motion_event(event: Event) -> None
Handle the mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: Event) -> None
Handle the mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: Event) -> None
Handle the mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: Event) -> None
Handle the left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: Event) -> None
Handle the left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: Event) -> None
Handle the middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: Event) -> None
Handle the middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: Event) -> None
Handle the right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: Event) -> None
Handle the right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle the mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle the mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle the mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle the left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle the middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle the right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle the mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle the left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle the middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle the right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle the mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle the mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event) -> None
Handle the mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object = None) -> None
Initialize the mouse manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> ArgumentParser
Add arguments to the argument parser.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Mouse pointer sprite.
instance-attribute
rect = Rect(pos, size)
property
writable
x: int
Get the x coordinate of the mouse pointer.
| Returns: |
|
|---|
property
writable
y: int
Get the y coordinate of the mouse pointer.
| Returns: |
|
|---|
__init__(pos: tuple, size: tuple = (1, 1)) -> None
Initialize the mouse pointer sprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
collided_sprites(scene: object, event: Event, index: int | None = None) -> list
Get the list of collided sprites.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Touch Event Manager.
Bases: ResourceManager
Touch event manager.
class-attribute
instance-attribute
__instances__: ClassVar = {}
Bases: TouchEvents, ResourceManager
Touch event proxy.
class-attribute
instance-attribute
log: Logger = LOG
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
fingers: dict = {}
instance-attribute
proxies: list = [game, touch]
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
__init__(game: object = None) -> None
Initialize the finger event proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle finger down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle finger motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle finger up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_multi_touch_down_event(event: Event) -> None
Handle multi-touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_multi_touch_motion_event(event: Event) -> None
Handle multi-touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_multi_touch_up_event(event: Event) -> None
Handle multi-touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object = None) -> None
Initialize the touch event manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Window.
module-attribute
LOG = getLogger('game.window')
Bases: ResourceManager
Window manager event handler.
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
proxies = [WindowManagerProxy(game=game)]
Bases: WindowEvents, ResourceManager
Window manager event proxy.
class-attribute
instance-attribute
log: Logger = LOG
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
proxies = [game]
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
__init__(game: object = None) -> None
Initialize the window manager proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_close_event(event: Event) -> None
Handle the window close event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle the window enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle the window exposed event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle the window focus gained event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle the window focus lost event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle the window hidden event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle the window hit test event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle the window leave event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle the window maximized event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle the window minimized event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle the window moved event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle the window resized event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle the window restored event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle the window shown event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle the window size changed event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle the window take focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object = None) -> None
Initialize the window event manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> ArgumentParser
Add window-specific arguments to the global parser.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Modules
Delta Time Demo.
Bases: Scene
The main game class.
class-attribute
instance-attribute
FPS = 0
instance-attribute
target_fps = 0
instance-attribute
fps = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
dirty = 1
instance-attribute
name = type(self)
instance-attribute
next_scene = self
instance-attribute
rects = None
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
all_sprites = groups
instance-attribute
background = Surface(get_size())
property
writable
background_color: Color
Return the background color.
| Returns: |
|
|---|
instance-attribute
image = screen
instance-attribute
rect = get_rect()
property
screenshot: Surface
Return a screenshot of the scene.
| Returns: |
|
|---|
class-attribute
instance-attribute
NAME = 'Delta Time Demo'
class-attribute
instance-attribute
VERSION = '1.0'
instance-attribute
font = SysFont('Calibri', 40)
instance-attribute
rect_pos = 0
instance-attribute
velocity = 5
instance-attribute
record = 0
instance-attribute
passed = False
instance-attribute
start = False
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_up_event(event: Event) -> None
Handle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle key up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joy button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joy button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
setup() -> None
Setup the scene.
| Returns: |
|
|---|
cleanup() -> None
Cleanup the scene.
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the active scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
sprites_at_position(pos: tuple) -> list[Sprite] | None
Return the sprites at a given position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load_resources() -> None
Load the scene's resources.
| Returns: |
|
|---|
__init__(options: dict, groups: LayeredDirty | None = None) -> None
Initialize the Game.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> None
Add game-specific arguments to the gloal parser.
This class method will get called automatically by the GameEngine class.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the scene.
This method will get called automatically by the GameEngine class.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the scene.
This method will get called automatically by the GameEngine class.
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle key down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
main() -> None
The main entry point for the game.
Joystick Demo.
module-attribute
LOG = getLogger('game')
Bases: Sprite
A sprite class for drawing shapes.
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [self]
instance-attribute
callbacks = {}
property
writable
width: int
Return the width of the sprite.
| Returns: |
|
|---|
property
writable
height: int
Return the height of the sprite.
| Returns: |
|
|---|
instance-attribute
use_gfxdraw = True
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
image = screen
instance-attribute
rect = get_rect()
instance-attribute
point = None
instance-attribute
circle = None
instance-attribute
triangle = None
instance-attribute
dirty = 1
property
rectangle: Rect
Get the rectangle.
| Returns: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
__init__(*args, **kwargs) -> None
Initialize a ShapesSprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
move(pos: tuple) -> None
Move the sprite to a new position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
Bases: Scene
A scene for testing joysticks.
class-attribute
instance-attribute
FPS = 0
class-attribute
instance-attribute
NAME = 'Unnamed Scene'
class-attribute
instance-attribute
VERSION = '0.0'
instance-attribute
target_fps = 0
instance-attribute
fps = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
dirty = 1
instance-attribute
scene_manager = SceneManager()
instance-attribute
name = type(self)
instance-attribute
next_scene = self
instance-attribute
rects = None
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
all_sprites = groups
instance-attribute
background = Surface(get_size())
property
writable
background_color: Color
Return the background color.
| Returns: |
|
|---|
instance-attribute
image = screen
instance-attribute
rect = get_rect()
property
screenshot: Surface
Return a screenshot of the scene.
| Returns: |
|
|---|
instance-attribute
tiles = []
instance-attribute
shapes_sprite = ShapesSprite(x=0, y=0, width=640, height=480)
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_up_event(event: Event) -> None
Handle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_down_event(event: Event) -> None
Handle key down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle key up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joy button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joy button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
setup() -> None
Setup the scene.
| Returns: |
|
|---|
cleanup() -> None
Cleanup the scene.
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the scene's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the active scene.
| Returns: |
|
|---|
sprites_at_position(pos: tuple) -> list[Sprite] | None
Return the sprites at a given position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(groups: LayeredDirty | None = None) -> None
Initialize the JoystickScene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load_resources() -> None
Load the resources.
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_pew_pew_event(event: Event) -> None
Handle pew pew events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_recharge_event(event: Event) -> None
Handle recharge events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: Scene
The main game class. This is where the magic happens.
class-attribute
instance-attribute
FPS = 0
instance-attribute
target_fps = 0
instance-attribute
fps = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
dirty = 1
instance-attribute
scene_manager = SceneManager()
instance-attribute
name = type(self)
instance-attribute
rects = None
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
all_sprites = groups
instance-attribute
background = Surface(get_size())
property
writable
background_color: Color
Return the background color.
| Returns: |
|
|---|
instance-attribute
image = screen
instance-attribute
rect = get_rect()
property
screenshot: Surface
Return a screenshot of the scene.
| Returns: |
|
|---|
class-attribute
instance-attribute
NAME = 'Joystick and Font Demo'
class-attribute
instance-attribute
VERSION = '0.0'
instance-attribute
time = get('time')
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_up_event(event: Event) -> None
Handle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_down_event(event: Event) -> None
Handle key down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle key up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joy button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joy button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
setup() -> None
Setup the scene.
| Returns: |
|
|---|
cleanup() -> None
Cleanup the scene.
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the scene's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the active scene.
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the active scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
sprites_at_position(pos: tuple) -> list[Sprite] | None
Return the sprites at a given position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load_resources() -> None
Load the scene's resources.
| Returns: |
|
|---|
__init__(options: dict) -> None
Initialize the game.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> None
Add arguments to the argument parser.
| Parameters: |
|
|---|
| Returns: |
|
|---|
main() -> None
The main function.
| Returns: |
|
|---|
Paddle Slap.
This is a simple game where you try to keep the ball from hitting your side of the screen.
module-attribute
log = getLogger('game')
Bases: Sprite
A sprite class for displaying text.
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [self]
instance-attribute
callbacks = {}
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
property
writable
width: int
Return the width of the sprite.
| Returns: |
|
|---|
property
writable
height: int
Return the height of the sprite.
| Returns: |
|
|---|
instance-attribute
background_color = background_color
instance-attribute
image = Surface((400, 400))
instance-attribute
screen = get_surface()
instance-attribute
rect = get_rect()
instance-attribute
font_manager = FontManager()
instance-attribute
joystick_manager = JoystickManager()
instance-attribute
joystick_count = len(joysticks)
instance-attribute
text_box = TextBox(font_controller=font_manager, pos=center)
instance-attribute
dirty = 2
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
__init__(
background_color: tuple = BLACKLUCENT,
alpha: int = 0,
x: int = 0,
y: int = 0,
groups: LayeredDirty | None = None,
) -> None
Initialize the text sprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the text sprite.
| Returns: |
|
|---|
Bases: Scene
The main game class. This is where the magic happens.
class-attribute
instance-attribute
FPS = 0
instance-attribute
target_fps = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
dirty = 1
instance-attribute
scene_manager = SceneManager()
instance-attribute
name = type(self)
instance-attribute
next_scene = self
instance-attribute
rects = None
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
background = Surface(get_size())
property
writable
background_color: Color
Return the background color.
| Returns: |
|
|---|
instance-attribute
image = screen
instance-attribute
rect = get_rect()
property
screenshot: Surface
Return a screenshot of the scene.
| Returns: |
|
|---|
class-attribute
instance-attribute
NAME = 'Paddle Slap'
class-attribute
instance-attribute
VERSION = '1.1'
instance-attribute
fps = 0
instance-attribute
player1 = VerticalPaddle(
"Player 1", (20, 80), (0, v_center - 40), WHITE, Speed(y=10, increment=1), collision_sound=SLAP
)
instance-attribute
player2 = VerticalPaddle(
"Player 2",
(20, 80),
(screen_width - 20, v_center - 40),
WHITE,
Speed(y=10, increment=1),
collision_sound=SLAP,
)
instance-attribute
balls = [BallSprite(collision_sound=BOUNCE) for _ in range(get('balls', 1))]
instance-attribute
all_sprites = LayeredDirty((player1, player2, *balls))
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_up_event(event: Event) -> None
Handle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joy button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joy button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cleanup() -> None
Cleanup the scene.
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the active scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
sprites_at_position(pos: tuple) -> list[Sprite] | None
Return the sprites at a given position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load_resources() -> None
Load the scene's resources.
| Returns: |
|
|---|
__init__(options: dict, groups: LayeredDirty | None = None) -> None
Initialize the Game.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> None
Add arguments to the argument parser.
| Parameters: |
|
|---|
| Returns: |
|
|---|
setup() -> None
Set up the game.
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the game.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the game.
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle key up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle key down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
main() -> None
The main function.
| Returns: |
|
|---|
Text Input Demo.
module-attribute
LOG = getLogger('game')
Bases: Scene
The main game class.
class-attribute
instance-attribute
FPS = 0
instance-attribute
target_fps = 0
instance-attribute
fps = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
dirty = 1
instance-attribute
scene_manager = SceneManager()
instance-attribute
name = type(self)
instance-attribute
next_scene = self
instance-attribute
rects = None
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
background = Surface(get_size())
instance-attribute
image = screen
instance-attribute
rect = get_rect()
property
screenshot: Surface
Return a screenshot of the scene.
| Returns: |
|
|---|
class-attribute
instance-attribute
NAME = 'Input Demo'
class-attribute
instance-attribute
VERSION = '1.0'
instance-attribute
input_box = InputBox(x=320, y=240, width=200, height=20, text='Test', parent=self, groups=groups)
instance-attribute
background_color = (255, 255, 0)
instance-attribute
all_sprites = LayeredDirty(input_box)
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joy button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joy button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cleanup() -> None
Cleanup the scene.
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the scene's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the active scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
sprites_at_position(pos: tuple) -> list[Sprite] | None
Return the sprites at a given position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load_resources() -> None
Load the scene's resources.
| Returns: |
|
|---|
__init__(options: dict, groups: LayeredDirty | None = None) -> None
Initialize the Game.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
setup() -> None
Set up the game.
| Returns: |
|
|---|
update() -> None
Update the game.
| Returns: |
|
|---|
on_input_box_submit_event(control: object) -> None
Handle input box submit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle key up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle key down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
main() -> None
The main entry point for the game.
Fonts.
This is a simple font manager that can be used to load fonts.
Attributes
module-attribute
log = getLogger('game.fonts')
Classes
Bases: ResourceManager
A font manager.
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
proxies = []
class-attribute
instance-attribute
OPTIONS: ClassVar = {}
class-attribute
instance-attribute
RENDER_CACHE: ClassVar = {}
Bases: FontEvents, ResourceManager
A font proxy.
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
proxies = [game, freetype]
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(game: object = None) -> None
Initialize the font proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__(game: object = None) -> None
Initialize the font manager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> ArgumentParser
Add font options to the argument parser.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
font(font_config: dict | None = None) -> Font | SysFont
Return a font object.
If the font requested can't be found then bitstream_vera will be loaded instead.
Note that if you are trying to package your game with pyinstaller, you'll need to bundle your game's fonts with the pyinstaller invocation. Make sure you have distribution rights to the fonts you're including with your game.
bitstream_vera is a permissively licensed font that can be used with your game.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Functions
load_sound(snd_file: str, volume: float = 0.25) -> Sound
Load a sound file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Modules
Ball.
Bases: Sprite
Ball Sprite.
instance-attribute
rect = get_rect()
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [self]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
property
writable
width: int
Return the width of the sprite.
| Returns: |
|
|---|
property
writable
height: int
Return the height of the sprite.
| Returns: |
|
|---|
instance-attribute
use_gfxdraw = True
instance-attribute
direction = 0
instance-attribute
speed = Speed(4, 2)
instance-attribute
dirty = 2
property
writable
color: tuple[int, int, int]
Get the color of the ball.
| Returns: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
__init__(
x: int = 0,
y: int = 0,
width: int = 20,
height: int = 20,
groups: LayeredDirty | None = None,
collision_sound: str | None = None,
) -> None
Initialize the ball sprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
reset() -> None
Reset the ball.
| Returns: |
|
|---|
bounce(diff: int) -> None
Bounce the ball.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the ball.
| Returns: |
|
|---|
Paddle.
module-attribute
log = getLogger('game.paddle')
Bases: Sprite
Base Paddle class.
instance-attribute
rect = get_rect()
instance-attribute
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [self]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
property
writable
width: int
Return the width of the sprite.
| Returns: |
|
|---|
property
writable
height: int
Return the height of the sprite.
| Returns: |
|
|---|
instance-attribute
use_gfxdraw = True
instance-attribute
moving = False
instance-attribute
snd = load_sound(collision_sound)
instance-attribute
dirty = 1
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
__init__(
axis: Horizontal | Vertical,
speed: int,
name: str,
color: tuple,
x: int,
y: int,
width: int,
height: int,
groups: LayeredDirty | None = None,
collision_sound: str | None = None,
) -> None
Initialize the paddle.
| Parameters: |
|
|---|
| Returns: |
|
|---|
move_horizontal() -> None
Move the paddle horizontally.
| Returns: |
|
|---|
move_vertical() -> None
Move the paddle vertically.
| Returns: |
|
|---|
is_at_bottom_of_screen() -> bool
Check if the paddle is at the bottom of the screen.
| Returns: |
|
|---|
is_at_top_of_screen() -> bool
Check if the paddle is at the top of the screen.
| Returns: |
|
|---|
is_at_left_of_screen() -> bool
Check if the paddle is at the left of the screen.
| Returns: |
|
|---|
is_at_right_of_screen() -> bool
Check if the paddle is at the right of the screen.
| Returns: |
|
|---|
Bases: BasePaddle
Horizontal Paddle.
instance-attribute
rect = get_rect()
instance-attribute
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [self]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
property
writable
width: int
Return the width of the sprite.
| Returns: |
|
|---|
property
writable
height: int
Return the height of the sprite.
| Returns: |
|
|---|
instance-attribute
use_gfxdraw = True
instance-attribute
moving = False
instance-attribute
snd = load_sound(collision_sound)
instance-attribute
dirty = 1
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
move_horizontal() -> None
Move the paddle horizontally.
| Returns: |
|
|---|
move_vertical() -> None
Move the paddle vertically.
| Returns: |
|
|---|
is_at_bottom_of_screen() -> bool
Check if the paddle is at the bottom of the screen.
| Returns: |
|
|---|
is_at_top_of_screen() -> bool
Check if the paddle is at the top of the screen.
| Returns: |
|
|---|
is_at_left_of_screen() -> bool
Check if the paddle is at the left of the screen.
| Returns: |
|
|---|
is_at_right_of_screen() -> bool
Check if the paddle is at the right of the screen.
| Returns: |
|
|---|
__init__(
name: str,
size: tuple,
position: tuple,
color: tuple,
speed: int,
groups: LayeredDirty | None = None,
collision_sound: str | None = None,
) -> None
Initialize the horizontal paddle.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the paddle.
| Returns: |
|
|---|
left() -> None
Move left.
| Returns: |
|
|---|
right() -> None
Move right.
| Returns: |
|
|---|
stop() -> None
Stop moving.
| Returns: |
|
|---|
speed_up() -> None
Speed up.
| Returns: |
|
|---|
Bases: BasePaddle
Vertical Paddle.
instance-attribute
rect = get_rect()
instance-attribute
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [self]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
property
writable
width: int
Return the width of the sprite.
| Returns: |
|
|---|
property
writable
height: int
Return the height of the sprite.
| Returns: |
|
|---|
instance-attribute
use_gfxdraw = True
instance-attribute
moving = False
instance-attribute
snd = load_sound(collision_sound)
instance-attribute
dirty = 1
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
move_horizontal() -> None
Move the paddle horizontally.
| Returns: |
|
|---|
move_vertical() -> None
Move the paddle vertically.
| Returns: |
|
|---|
is_at_bottom_of_screen() -> bool
Check if the paddle is at the bottom of the screen.
| Returns: |
|
|---|
is_at_top_of_screen() -> bool
Check if the paddle is at the top of the screen.
| Returns: |
|
|---|
is_at_left_of_screen() -> bool
Check if the paddle is at the left of the screen.
| Returns: |
|
|---|
is_at_right_of_screen() -> bool
Check if the paddle is at the right of the screen.
| Returns: |
|
|---|
__init__(
name: str,
size: tuple,
position: tuple,
color: tuple,
speed: int,
groups: LayeredDirty | None = None,
collision_sound: str | None = None,
) -> None
Initialize the vertical paddle.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the paddle.
| Returns: |
|
|---|
up() -> None
Move up.
| Returns: |
|
|---|
down() -> None
Move down.
| Returns: |
|
|---|
stop() -> None
Stop moving.
| Returns: |
|
|---|
speed_up() -> None
Speed up.
| Returns: |
|
|---|
Sounds.
Sound effects.
class-attribute
instance-attribute
BOUNCE = 'sfx_bounce.wav'
class-attribute
instance-attribute
SLAP = 'sfx_slap.wav'
Modules
Interfaces for the game.
Sprite interface.
update_nested_sprites() -> None
Update the nested sprites.
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the sprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Scene interface.
switch_to_scene(next_scene: SceneInterface) -> None
Switch to the next scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
terminate() -> None
Terminate the scene.
| Returns: |
|
|---|
play() -> None
Play the scene.
| Returns: |
|
|---|
pause() -> None
Pause the scene.
| Returns: |
|
|---|
Modules
Horizontal Movement.
This is a simple horizontal movement class that can be used to move sprites left and right.
Horizontal movement.
instance-attribute
current_speed = x
__init__(speed: int) -> None
Initialize the horizontal movement.
| Parameters: |
|
|---|
| Returns: |
|
|---|
left() -> None
Move left.
| Returns: |
|
|---|
right() -> None
Move right.
| Returns: |
|
|---|
stop() -> None
Stop moving.
| Returns: |
|
|---|
Speed.
This is a simple speed class that can be used to speed up sprites.
Speed.
__init__(x: int = 0, y: int = 0, increment: float = 0.2) -> None
Initialize the speed.
| Parameters: |
|
|---|
| Returns: |
|
|---|
speed_up() -> None
Speed up.
| Returns: |
|
|---|
speed_up_horizontal() -> None
Speed up horizontally.
| Returns: |
|
|---|
speed_up_vertical() -> None
Speed up vertically.
| Returns: |
|
|---|
Vertical Movement.
This is a simple vertical movement class that can be used to move sprites up and down.
Vertical movement.
instance-attribute
current_speed = y
__init__(speed: int) -> None
Initialize the vertical movement.
| Parameters: |
|
|---|
| Returns: |
|
|---|
up() -> None
Move up.
| Returns: |
|
|---|
down() -> None
Move down.
| Returns: |
|
|---|
stop() -> None
Stop moving.
| Returns: |
|
|---|
Pixel data handling.
Attributes
module-attribute
LOG = getLogger('game.pixels')
Functions
indexed_rgb_triplet_generator(pixel_data: iter) -> iter[tuple[int, int, int]]
Yield (R, G, B) pixel tuples from a buffer of pixel tuples.
rgb_555_triplet_generator(pixel_data: iter) -> iter[tuple[int, int, int]]
Yield (R, G, B) pixel tuples for 555 formated color data.
rgb_565_triplet_generator(pixel_data: iter) -> iter[tuple[int, int, int]]
Yield (R, G, B) tuples for 565 formatted color data.
rgb_triplet_generator(pixel_data: iter) -> iter[tuple[int, int, int]]
Yield (R, G, B) tuples for the provided pixel data.
image_from_pixels(pixels: list, width: int, height: int) -> Surface
Produce a pygame.image object for the specified [(R, G, B), ...] pixel data.
pixels_from_data(pixel_data: list) -> list
Expand raw pixel data into [(R, G, B), ...] triplets.
pixels_from_path(path: str) -> list
Expand raw pixel data from file into [(R, G, B), ...] triplets.
Glitchy Games Engine scenes module.
Attributes
module-attribute
LOG = getLogger('game.scenes')
Classes
Bases: SceneInterface, EventManager
Glitchy Games Scene Manager.
The scene manager is responsible for managing the active scene, and for processing events.
class-attribute
instance-attribute
__instances__: ClassVar = {}
instance-attribute
proxies = [EventProxy(event_source=self)]
class-attribute
instance-attribute
OPTIONS: ClassVar = {}
instance-attribute
screen = get_surface()
instance-attribute
update_type = 'update'
instance-attribute
fps_refresh_rate = 1000
instance-attribute
target_fps = 0
instance-attribute
dt = 0
instance-attribute
timer = 0
instance-attribute
active_scene = None
instance-attribute
next_scene = active_scene
instance-attribute
previous_scene = active_scene
instance-attribute
quit_requested = False
instance-attribute
clock = Clock()
property
writable
game_engine: object
Return the game engine.
| Returns: |
|
|---|
property
all_sprites: LayeredDirty | None
Return the active scene's sprite group.
| Returns: |
|
|---|
Proxy for events.
class-attribute
instance-attribute
log: Logger = LOG
instance-attribute
proxies = []
instance-attribute
event_source = event_source
__init__(event_source: object) -> None
Initialize the event proxy.
| Parameters: |
|
|---|
| Returns: |
|
|---|
unhandled_event(*args, **kwargs) -> None
Handle unhandled events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__getattr__(attr: str) -> Callable
Get an attribute.
This method is called when an attribute is not found.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__new__(*args, **kwargs) -> object
Create a new instance of the class.
This method is called when a new instance of the class
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
__init__() -> None
Initialize the scene manager.
| Returns: |
|
|---|
switch_to_scene(next_scene: Scene) -> None
Switch to the next scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
play() -> None
start() -> None
Start the scene manager.
| Returns: |
|
|---|
stop() -> None
terminate() -> None
Terminate the scene manager.
| Returns: |
|
|---|
quit() -> None
Quit the game.
| Returns: |
|
|---|
quit_game() -> None
Quit the game.
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
register_game_event(event_type: EventType, callback: Callable) -> None
Register a game event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__getattr__(attr: str) -> Callable
Proxy calls to the active scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: SceneInterface, SpriteInterface, AllEventStubs
Scene object base class.
Subclass this to properly receive on_*_event() messages automatically.
class-attribute
instance-attribute
FPS = 0
class-attribute
instance-attribute
NAME = 'Unnamed Scene'
class-attribute
instance-attribute
VERSION = '0.0'
instance-attribute
target_fps = 0
instance-attribute
fps = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
name = type(self)
instance-attribute
next_scene = self
instance-attribute
rects = None
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
all_sprites = groups
instance-attribute
screen = get_surface()
instance-attribute
background = Surface(get_size())
instance-attribute
image = screen
instance-attribute
rect = get_rect()
instance-attribute
dirty = 1
property
screenshot: Surface
Return a screenshot of the scene.
| Returns: |
|
|---|
property
writable
background_color: Color
Return the background color.
| Returns: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
cached
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_up_event(event: Event) -> None
Handle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_down_event(event: Event) -> None
Handle key down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(options: dict | None = None, groups: LayeredDirty | None = None) -> None
Initialize the scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
setup() -> None
Setup the scene.
| Returns: |
|
|---|
cleanup() -> None
Cleanup the scene.
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the scene's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the active scene.
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the active scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
sprites_at_position(pos: tuple) -> list[Sprite] | None
Return the sprites at a given position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joy button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joy button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle key up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load_resources() -> None
Load the scene's resources.
| Returns: |
|
|---|
Modules
Glitchy Games Engine sprite module.
Attributes
module-attribute
LOG = getLogger('game.sprites')
Classes
Bases: MouseEvents, SpriteInterface, DirtySprite
A root sprite class. All Glitchy Games sprites inherit from this class.
instance-attribute
rect = Rect(0, 0, 0, 0)
instance-attribute
image = None
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
abstractmethod
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_button_up_event(event: Event) -> None
Handle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
abstractmethod
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(groups: LayeredDirty | None = None) -> None
Initialize a RootSprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: RootSprite
A convenience class for handling all of the common sprite behaviors.
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
rect = get_rect()
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [self]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
property
writable
width: int
Return the width of the sprite.
| Returns: |
|
|---|
property
writable
height: int
Return the height of the sprite.
| Returns: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
parent: object | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize a Sprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
Bases: Sprite
A sprite that loads from a Bitmappy config file.
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
instance-attribute
width = width
instance-attribute
height = height
instance-attribute
image = Surface((width, height))
instance-attribute
rect = get_rect()
instance-attribute
proxies = [parent]
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
filename: str | None = None,
focusable: bool = False,
parent: object = None,
groups: LayeredDirty | None = None,
) -> None
Subclass to load sprite files.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
A generic singleton class.
class-attribute
instance-attribute
__instance__ = None
__new__(*args, **kwargs) -> Self
Create a new instance of the Singleton.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: BitmappySprite
A singleton class for handling singleton sprites, like mouse pointers.
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
class-attribute
instance-attribute
__instance__ = None
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__new__(*args, **kwargs) -> Self
Create a new instance of the SingletonBitmappySprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize the SingletonBitmappySprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: BitmappySprite
A singleton class for handling all of the focusable sprite behaviors.
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
log = LOG
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
instance-attribute
filename = filename
instance-attribute
focusable = focusable
class-attribute
instance-attribute
__instance__ = None
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__new__(*args, **kwargs) -> Self
Create a new instance of the FocusableSingletonBitmappySprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize the FocusableSingletonBitmappySprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Functions
This module helps build a project from templates. It's a wrapper around cookiecutter.
Attributes
module-attribute
path = parent
Functions
get_templates() -> list
Returns a list of templates.
build(template: str) -> None
Builds the project from the template, using cookiecutter.
Modules
Glitchy Games Bitmap Editor.
module-attribute
LOG = getLogger('game')
module-attribute
MAX_PIXELS_ACROSS = 64
module-attribute
MIN_PIXELS_ACROSS = 1
module-attribute
MAX_PIXELS_TALL = 64
module-attribute
MIN_PIXELS_TALL = 1
module-attribute
MIN_COLOR_VALUE = 0
module-attribute
MAX_COLOR_VALUE = 255
Bases: Exception
Glitchy Games Unhandled Menu Item Error.
Bases: Scene
Input Confirmation Dialog Scene.
class-attribute
instance-attribute
FPS = 0
instance-attribute
target_fps = 0
instance-attribute
fps = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
dirty = 1
instance-attribute
options = options
instance-attribute
scene_manager = SceneManager()
instance-attribute
name = type(self)
instance-attribute
next_scene = self
instance-attribute
rects = None
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
all_sprites = groups
instance-attribute
background = Surface(get_size())
property
writable
background_color: Color
Return the background color.
| Returns: |
|
|---|
instance-attribute
image = screen
instance-attribute
rect = get_rect()
property
screenshot: Surface
Return a screenshot of the scene.
| Returns: |
|
|---|
class-attribute
instance-attribute
log = LOG
class-attribute
instance-attribute
NAME = 'InputConfirmationDialog'
class-attribute
instance-attribute
DIALOG_TEXT = 'Would you like to do a thing?'
class-attribute
instance-attribute
CONFIRMATION_TEXT = 'Confirm'
class-attribute
instance-attribute
CANCEL_TEXT = 'Cancel'
class-attribute
instance-attribute
VERSION = ''
instance-attribute
previous_scene = previous_scene
instance-attribute
dialog = InputDialog(
name=NAME,
dialog_text=DIALOG_TEXT,
confirm_text=CONFIRMATION_TEXT,
x=center[0] // 2,
y=center[1] // 2,
width=screen_width // 2,
height=screen_height // 2,
parent=self,
groups=all_sprites,
)
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joy button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joy button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the scene's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the active scene.
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the active scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
sprites_at_position(pos: tuple) -> list[Sprite] | None
Return the sprites at a given position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load_resources() -> None
Load the scene's resources.
| Returns: |
|
|---|
__init__(
previous_scene: Scene, options: dict | None = None, groups: LayeredDirty | None = None
) -> None
Initialize the Input Confirmation Dialog Scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
setup() -> None
Setup the scene.
| Returns: |
|
|---|
cleanup() -> None
Cleanup the scene.
| Returns: |
|
|---|
dismiss() -> None
Dismiss the dialog.
| Returns: |
|
|---|
on_cancel_event(event: Event, trigger: object) -> None
Handle the cancel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_confirm_event(event: Event, trigger: object) -> None
Handle the confirm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_input_box_submit_event(control: object) -> None
Handle the input box submit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle the mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle the key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle the key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: InputConfirmationDialogScene
New Canvas Dialog Scene.
class-attribute
instance-attribute
FPS = 0
class-attribute
instance-attribute
VERSION = ''
instance-attribute
target_fps = 0
instance-attribute
fps = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
dirty = 1
instance-attribute
scene_manager = SceneManager()
instance-attribute
name = type(self)
instance-attribute
next_scene = self
instance-attribute
rects = None
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
all_sprites = groups
instance-attribute
background = Surface(get_size())
property
writable
background_color: Color
Return the background color.
| Returns: |
|
|---|
instance-attribute
image = screen
instance-attribute
rect = get_rect()
property
screenshot: Surface
Return a screenshot of the scene.
| Returns: |
|
|---|
instance-attribute
previous_scene = previous_scene
instance-attribute
dialog = InputDialog(
name=NAME,
dialog_text=DIALOG_TEXT,
confirm_text=CONFIRMATION_TEXT,
x=center[0] // 2,
y=center[1] // 2,
width=screen_width // 2,
height=screen_height // 2,
parent=self,
groups=all_sprites,
)
class-attribute
instance-attribute
NAME = 'New Canvas'
class-attribute
instance-attribute
DIALOG_TEXT = 'Are you sure you want to clear the canvas?'
class-attribute
instance-attribute
CONFIRMATION_TEXT = 'Clear'
class-attribute
instance-attribute
CANCEL_TEXT = 'Cancel'
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle the mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle the key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle the key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joy button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joy button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
setup() -> None
Setup the scene.
| Returns: |
|
|---|
cleanup() -> None
Cleanup the scene.
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the scene's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the active scene.
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the active scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
sprites_at_position(pos: tuple) -> list[Sprite] | None
Return the sprites at a given position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load_resources() -> None
Load the scene's resources.
| Returns: |
|
|---|
dismiss() -> None
Dismiss the dialog.
| Returns: |
|
|---|
on_cancel_event(event: Event, trigger: object) -> None
Handle the cancel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_input_box_submit_event(control: object) -> None
Handle the input box submit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(
previous_scene: Scene, options: dict | None = None, groups: LayeredDirty | None = None
) -> None
Initialize the New Canvas Dialog Scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_confirm_event(event: Event, trigger: object) -> None
Handle the confirm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: InputConfirmationDialogScene
Load Dialog Scene.
class-attribute
instance-attribute
FPS = 0
instance-attribute
target_fps = 0
instance-attribute
fps = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
dirty = 1
instance-attribute
scene_manager = SceneManager()
instance-attribute
name = type(self)
instance-attribute
next_scene = self
instance-attribute
rects = None
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
all_sprites = groups
instance-attribute
background = Surface(get_size())
property
writable
background_color: Color
Return the background color.
| Returns: |
|
|---|
instance-attribute
image = screen
instance-attribute
rect = get_rect()
property
screenshot: Surface
Return a screenshot of the scene.
| Returns: |
|
|---|
instance-attribute
previous_scene = previous_scene
instance-attribute
dialog = InputDialog(
name=NAME,
dialog_text=DIALOG_TEXT,
confirm_text=CONFIRMATION_TEXT,
x=center[0] // 2,
y=center[1] // 2,
width=screen_width // 2,
height=screen_height // 2,
parent=self,
groups=all_sprites,
)
class-attribute
instance-attribute
NAME = 'Load Sprite'
class-attribute
instance-attribute
DIALOG_TEXT = 'Would you like to load a sprite?'
class-attribute
instance-attribute
CONFIRMATION_TEXT = 'Load'
class-attribute
instance-attribute
CANCEL_TEXT = 'Cancel'
class-attribute
instance-attribute
VERSION = ''
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle the mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle the key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle the key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joy button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joy button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
setup() -> None
Setup the scene.
| Returns: |
|
|---|
cleanup() -> None
Cleanup the scene.
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the scene's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the active scene.
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the active scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
sprites_at_position(pos: tuple) -> list[Sprite] | None
Return the sprites at a given position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load_resources() -> None
Load the scene's resources.
| Returns: |
|
|---|
dismiss() -> None
Dismiss the dialog.
| Returns: |
|
|---|
on_cancel_event(event: Event, trigger: object) -> None
Handle the cancel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_input_box_submit_event(control: object) -> None
Handle the input box submit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(
previous_scene: Scene, options: dict | None = None, groups: LayeredDirty | None = None
) -> None
Initialize the Load Dialog Scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_confirm_event(event: Event, trigger: object) -> None
Handle the confirm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: InputConfirmationDialogScene
Save Dialog Scene.
class-attribute
instance-attribute
FPS = 0
instance-attribute
target_fps = 0
instance-attribute
fps = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
dirty = 1
instance-attribute
scene_manager = SceneManager()
instance-attribute
name = type(self)
instance-attribute
next_scene = self
instance-attribute
rects = None
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
all_sprites = groups
instance-attribute
background = Surface(get_size())
property
writable
background_color: Color
Return the background color.
| Returns: |
|
|---|
instance-attribute
image = screen
instance-attribute
rect = get_rect()
property
screenshot: Surface
Return a screenshot of the scene.
| Returns: |
|
|---|
instance-attribute
previous_scene = previous_scene
instance-attribute
dialog = InputDialog(
name=NAME,
dialog_text=DIALOG_TEXT,
confirm_text=CONFIRMATION_TEXT,
x=center[0] // 2,
y=center[1] // 2,
width=screen_width // 2,
height=screen_height // 2,
parent=self,
groups=all_sprites,
)
class-attribute
instance-attribute
NAME = 'Save Sprite'
class-attribute
instance-attribute
DIALOG_TEXT = 'Would you like to save your sprite?'
class-attribute
instance-attribute
CONFIRMATION_TEXT = 'Save'
class-attribute
instance-attribute
CANCEL_TEXT = 'Cancel'
class-attribute
instance-attribute
VERSION = ''
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle the mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle right mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle the key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle the key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joy button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joy button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_menu_item_event(event: Event) -> None
Handle menu item events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
setup() -> None
Setup the scene.
| Returns: |
|
|---|
cleanup() -> None
Cleanup the scene.
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the scene's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the active scene.
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the active scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
sprites_at_position(pos: tuple) -> list[Sprite] | None
Return the sprites at a given position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load_resources() -> None
Load the scene's resources.
| Returns: |
|
|---|
dismiss() -> None
Dismiss the dialog.
| Returns: |
|
|---|
on_cancel_event(event: Event, trigger: object) -> None
Handle the cancel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_input_box_submit_event(control: object) -> None
Handle the input box submit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(
previous_scene: Scene, options: dict | None = None, groups: LayeredDirty | None = None
) -> None
Initialize the Save Dialog Scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_confirm_event(event: Event, trigger: object) -> None
Handle the confirm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: BitmappySprite
Bitmap Pixel Sprite.
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
class-attribute
instance-attribute
PIXEL_CACHE: ClassVar = {}
instance-attribute
pixel_number = pixel_number
instance-attribute
border_thickness = border_thickness
instance-attribute
width = pixel_width
instance-attribute
height = pixel_height
instance-attribute
color = (96, 96, 96)
instance-attribute
rect = rect(image, color, (x, y, width, height), border_thickness)
property
writable
pixel_color: tuple[int, int, int]
Get the pixel color.
| Returns: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__init__(
x: int = 0,
y: int = 0,
width: int = 1,
height: int = 1,
name: str | None = None,
pixel_number: int = 0,
border_thickness: int = 1,
groups: LayeredDirty | None = None,
) -> None
Initialize the Bitmap Pixel Sprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
on_pixel_update_event(event: Event) -> None
Handle the pixel update event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle the left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: BitmappySprite
Canvas.
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__init__() -> None
Create a Canvas.
update() -> None
Update the canvas.
Bases: BitmappySprite
Canvas Sprite.
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
class-attribute
instance-attribute
WIDTH = 32
class-attribute
instance-attribute
HEIGHT = 32
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
PIXEL_CACHE: ClassVar = {}
instance-attribute
character_sprite = False
instance-attribute
border_thickness = 0
instance-attribute
border_margin = 0
instance-attribute
pixels = [(255, 0, 255)] * pixels_across * pixels_tall
instance-attribute
grid_line_width = 0
instance-attribute
pixel_width = 1
instance-attribute
pixel_height = 1
instance-attribute
mini_view = None
instance-attribute
resize_widget = None
instance-attribute
active_color = (255, 255, 255)
instance-attribute
name = 'Bitmap Canvas'
instance-attribute
all_sprites = groups
instance-attribute
pixel_boxes = [
BitmapPixelSprite(
name=f"pixel {i}", pixel_number=i, x=0, y=0, height=pixel_width, width=pixel_height
)
for i in range(pixels_across * pixels_tall)
]
instance-attribute
update_anyway = False
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str,
has_mini_view: bool = True,
groups: None | LayeredDirty = None,
) -> None
Initialize the Canvas Sprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_pixel_update_event(event: Event, trigger: object) -> None
Handle the pixel update event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update_nested_sprites() -> None
Update the nested sprites.
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle the left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle the left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_new_file_event(event: Event, trigger: object) -> None
Handle the new file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_save_file_event(event: Event, trigger: object) -> None
Handle the save file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_load_file_event(event: Event, trigger: object) -> None
Handle the load file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: CanvasSprite
Mini View.
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
name = 'Bitmap Canvas'
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
class-attribute
instance-attribute
WIDTH = 32
class-attribute
instance-attribute
HEIGHT = 32
class-attribute
instance-attribute
PIXEL_CACHE: ClassVar = {}
instance-attribute
character_sprite = False
instance-attribute
pixel_boxes = [
BitmapPixelSprite(
name=f"pixel {i}", pixel_number=i, x=0, y=0, height=pixel_width, width=pixel_height
)
for i in range(pixels_across * pixels_tall)
]
instance-attribute
pixel_width = 1
instance-attribute
pixel_height = 1
instance-attribute
mini_view = None
instance-attribute
resize_widget = None
instance-attribute
active_color = (255, 255, 255)
instance-attribute
all_sprites = groups
instance-attribute
update_anyway = False
instance-attribute
width = pixels_across * pixel_width
instance-attribute
height = pixels_tall * pixel_height
instance-attribute
border_thickness = 0
instance-attribute
border_margin = 0
instance-attribute
grid_line_width = 0
instance-attribute
image = Surface((width, height))
instance-attribute
rect = get_rect()
instance-attribute
color_palette = [(0, 255, 0), (255, 0, 255), (255, 255, 0), (0, 0, 0)]
instance-attribute
palette_index = 0
instance-attribute
dirty_pixels = [True] * len(pixels)
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle the left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle the left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
on_pixel_update_event(event: Event, trigger: object) -> None
Handle the pixel update event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_new_file_event(event: Event, trigger: object) -> None
Handle the new file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_save_file_event(event: Event, trigger: object) -> None
Handle the save file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_load_file_event(event: Event, trigger: object) -> None
Handle the load file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
staticmethod
pixels_per_pixel(pixels_across: int, pixels_tall: int) -> tuple[int, int]
Get the pixels per pixel.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(
x: int = 0,
y: int = 0,
width: int = 0,
height: int = 0,
name: str | None = None,
border_thickness: int = 0,
pixels: list | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize the Mini View.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update_nested_sprites() -> None
Update the nested sprites.
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle the left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Get the string representation of the Mini View.
| Returns: |
|
|---|
Bases: Scene
Bitmap Editor Scene.
class-attribute
instance-attribute
FPS = 0
instance-attribute
target_fps = 0
instance-attribute
fps = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
dirty = 1
instance-attribute
scene_manager = SceneManager()
instance-attribute
name = type(self)
instance-attribute
next_scene = self
instance-attribute
rects = None
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
all_sprites = groups
instance-attribute
background = Surface(get_size())
property
writable
background_color: Color
Return the background color.
| Returns: |
|
|---|
instance-attribute
image = screen
instance-attribute
rect = get_rect()
property
screenshot: Surface
Return a screenshot of the scene.
| Returns: |
|
|---|
class-attribute
instance-attribute
NAME = 'Bitmappy'
class-attribute
instance-attribute
VERSION = '1.0'
instance-attribute
menu_bar = MenuBar(name='Menu Bar', x=0, y=0, width=screen_width, height=20, groups=all_sprites)
instance-attribute
menu_icon = MenuItem(
name=None, filename=parent / "resources" / "bitmappy.cfg", x=0, y=0, width=16, height=height
)
instance-attribute
canvas = CanvasSprite(
name="Bitmap Canvas",
x=0,
y=32,
width=int(screen_height * 0.75),
height=int(screen_height * 0.75),
groups=all_sprites,
)
instance-attribute
red_slider = SliderSprite(
name="R", x=10, y=screen_height - 70, width=256, height=slider_height, groups=all_sprites
)
instance-attribute
green_slider = SliderSprite(
name="G", x=10, y=screen_height - 50, width=256, height=slider_height, groups=all_sprites
)
instance-attribute
blue_slider = SliderSprite(
name="B", x=10, y=screen_height - 30, width=256, height=slider_height, groups=all_sprites
)
instance-attribute
color_well = ColorWellSprite(
name="Colorwell", x=midright[0] + 30, y=y, width=64, height=64, groups=groups
)
instance-attribute
new_canvas_dialog_scene = NewCanvasDialogScene(options=options, previous_scene=self)
instance-attribute
load_dialog_scene = LoadDialogScene(options=options, previous_scene=self)
instance-attribute
save_dialog_scene = SaveDialogScene(options=options, previous_scene=self)
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_window_close_event(event: Event) -> None
Handle window close events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_enter_event(event: Event) -> None
Handle window enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_exposed_event(event: Event) -> None
Handle window exposed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_gained_event(event: Event) -> None
Handle window focus gained events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_focus_lost_event(event: Event) -> None
Handle window focus lost events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hidden_event(event: Event) -> None
Handle window hidden events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_hit_test_event(event: Event) -> None
Handle window hit test events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_leave_event(event: Event) -> None
Handle window leave events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_maximized_event(event: Event) -> None
Handle window maximized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_minimized_event(event: Event) -> None
Handle window minimized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_moved_event(event: Event) -> None
Handle window moved events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_resized_event(event: Event) -> None
Handle window resized events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_restored_event(event: Event) -> None
Handle window restored events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_shown_event(event: Event) -> None
Handle window shown events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_size_changed_event(event: Event) -> None
Handle window size changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_window_take_focus_event(event: Event) -> None
Handle window take focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_editing_event(event: Event) -> None
Handle text editing events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_text_input_event(event: Event) -> None
Handle text input events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_up_event(event: Event) -> None
Handle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle middle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_button_down_event(event: Event) -> None
Handle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle middle mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle right mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_down_event(event: Event) -> None
Handle mouse scroll down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_scroll_up_event(event: Event) -> None
Handle mouse scroll up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_down_event(event: Event) -> None
Handle key down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle key up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_up_event(event: Event, keys: list) -> None
Handle key chord up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_key_chord_down_event(event: Event, keys: list) -> None
Handle key chord down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_axis_motion_event(event: Event) -> None
Handle joystick axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle joy button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle joy button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_hat_motion_event(event: Event) -> None
Handle joystick hat motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_ball_motion_event(event: Event) -> None
Handle joystick ball motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_added_event(event: Event) -> None
Handle joystick device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_joy_device_removed_event(event: Event) -> None
Handle joystick device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_active_event(event: Event) -> None
Handle active events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_fps_event(event: Event) -> None
Handle FPS events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_game_event(event: Event) -> None
Handle game events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle sys wm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle user events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle video expose events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle video resize events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle quit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_font_changed_event(event: Event) -> None
Handle font changed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_down_event(event: Event) -> None
Handle touch down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_motion_event(event: Event) -> None
Handle touch motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_touch_up_event(event: Event) -> None
Handle touch up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_down_event(event: Event) -> None
Handle multi finger down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_motion_event(event: Event) -> None
Handle multi finger motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_multi_touch_up_event(event: Event) -> None
Handle multi finger up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_begin_event(event: Event) -> None
Handle drop begin event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_file_event(event: Event) -> None
Handle drop file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_text_event(event: Event) -> None
Handle drop text event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_drop_complete_event(event: Event) -> None
Handle drop complete event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_axis_motion_event(event: Event) -> None
Handle controller axis motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_down_event(event: Event) -> None
Handle controller button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_controller_button_up_event(event: Event) -> None
Handle controller button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_added_event(event: Event) -> None
Handle controller device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_remapped_event(event: Event) -> None
Handle controller device remapped events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_device_removed_event(event: Event) -> None
Handle controller device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_down_event(event: Event) -> None
Handle controller touchpad down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_motion_event(event: Event) -> None
Handle controller touchpad motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_controller_touchpad_up_event(event: Event) -> None
Handle controller touchpad up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_added_event(event: Event) -> None
Handle audio device added events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
cached
on_audio_device_removed_event(event: Event) -> None
Handle audio device removed events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
setup() -> None
Setup the scene.
| Returns: |
|
|---|
cleanup() -> None
Cleanup the scene.
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the scene's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the active scene.
| Returns: |
|
|---|
render(screen: Surface) -> None
Render the active scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
sprites_at_position(pos: tuple) -> list[Sprite] | None
Return the sprites at a given position.
| Parameters: |
|
|---|
| Returns: |
|
|---|
load_resources() -> None
Load the scene's resources.
| Returns: |
|
|---|
__init__(options: dict, groups: LayeredDirty | None = None) -> None
Initialize the Bitmap Editor Scene.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_menu_item_event(event: Event) -> None
Handle the menu item event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_new_file_event(event: Event) -> None
Handle the new file event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_new_canvas_dialog_event(event: Event) -> None
Handle the new canvas dialog event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_load_dialog_event(event: Event) -> None
Handle the load dialog event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_save_dialog_event(event: Event) -> None
Handle the save dialog event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_color_well_event(event: Event, trigger: object) -> None
Handle the color well event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_slider_event(event: Event, trigger: object) -> None
Handle the slider event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle the right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle the left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle the left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle the left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
args(parser: ArgumentParser) -> None
Add command line arguments.
| Parameters: |
|
|---|
| Returns: |
|
|---|
main() -> None
Main function.
| Returns: |
|
|---|
GlitchyGames UI classes.
Attributes
module-attribute
LOG = getLogger('game.ui')
Classes
Bases: FocusableSingletonBitmappySprite
A menu bar class.
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
class-attribute
instance-attribute
__instance__ = None
instance-attribute
all_sprites = groups
instance-attribute
background_color = (0, 255, 0)
instance-attribute
border_width = 2
instance-attribute
menu_items = {}
instance-attribute
menu_offset_x = border_width
instance-attribute
menu_offset_y = border_width
instance-attribute
has_focus = False
instance-attribute
dirty = 2
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__new__(*args, **kwargs) -> Self
Create a new instance of the FocusableSingletonBitmappySprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize a MenuBar.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_menu(menu: MenuItem) -> None
update() -> None
Update the menu bar.
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle mouse enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle mouse exit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: BitmappySprite
A menu item class.
This class represents a menu item. It can be a root level menu item or a sub menu item.
| Parameters: |
|
|---|
| Returns: |
|
|---|
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
instance-attribute
all_sprites = groups
instance-attribute
background_color = (255, 0, 255)
instance-attribute
border_width = 2
instance-attribute
menu_items = {}
instance-attribute
menu_offset_x = border_width
instance-attribute
menu_offset_y = border_width
instance-attribute
menu_image = None
instance-attribute
menu_rect = None
instance-attribute
active = False
instance-attribute
text = TextSprite(
background_color=background_color,
text_color=(0, 0, 0),
x=x,
y=y,
width=width,
height=height,
text=name,
parent=parent,
groups=groups,
)
instance-attribute
menu_up_image = image
instance-attribute
menu_up_rect = rect
instance-attribute
menu_down_image = menu_up_image
instance-attribute
menu_down_rect = menu_up_rect
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__init__(
x: int = 0,
y: int = 0,
width: int = 1,
height: int = 1,
name: str | None = None,
filename: str | None = None,
parent: object | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize a MenuItem.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add(*groups: LayeredDirty) -> None
Add the sprite to a group.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_menu(menu: MenuItem) -> None
update() -> None
Update the menu item.
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event) -> None
Handle left mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event) -> None
Handle middle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event) -> None
Handle middle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event) -> None
Handle mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event) -> None
Handle mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_motion_event(event: Event) -> None
Handle mouse motion events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle mouse enter events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle mouse exit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event) -> None
Handle right mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event) -> None
Handle right mouse drop events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event) -> None
Handle mouse wheel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: BitmappySprite
A text sprite class.
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
instance-attribute
background_color = (255, 0, 255)
instance-attribute
active_color = background_color
instance-attribute
click_color = (0, 255, 128)
instance-attribute
hover_color = (255, 255, 0)
instance-attribute
alpha = 0
instance-attribute
text_box = TextBox(
font=font(), x=x, y=x, text=text, text_color=text_color, parent=self, groups=groups
)
instance-attribute
proxies = [parent]
property
writable
x: int
Get the x coordinate of the text sprite.
| Returns: |
|
|---|
property
writable
y: int
Get the y coordinate of the text sprite.
| Returns: |
|
|---|
Bases: Sprite
A text box class.
instance-attribute
rect = get_rect()
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
property
writable
width: int
Return the width of the sprite.
| Returns: |
|
|---|
property
writable
height: int
Return the height of the sprite.
| Returns: |
|
|---|
instance-attribute
text_hover_color = (255, 255, 255)
instance-attribute
text_click_color = (63, 127, 255)
instance-attribute
background_color = (255, 0, 255)
instance-attribute
background_hover_color = (0, 255, 128)
instance-attribute
background_click_color = (255, 127, 63)
instance-attribute
active_text_color = text_color
instance-attribute
active_background_color = background_color
property
writable
x: int
Get the x coordinate of the text box.
| Returns: |
|
|---|
property
writable
y: int
Get the y coordinate of the text box.
| Returns: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
__init__(
font: str,
x: int,
y: int,
line_height: int = 15,
text: str = "Text",
text_color: tuple = WHITE,
parent: object = None,
groups: LayeredDirty | None = None,
) -> None
Initialize a TextBox.
| Parameters: |
|
|---|
| Returns: |
|
|---|
print_text(surface: Surface, string: str) -> None
Print text to the text box.
| Parameters: |
|
|---|
| Returns: |
|
|---|
reset() -> None
Reset the text box.
| Returns: |
|
|---|
indent() -> None
Indent the text box.
| Returns: |
|
|---|
unindent() -> None
Unindent the text box.
| Returns: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
background_color: tuple = BLACKLUCENT,
text_color: tuple = WHITE,
alpha: int = 0,
text: str = "Text",
parent: object | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize a TextSprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update_nested_sprites() -> None
Update the nested sprites.
| Returns: |
|
|---|
update() -> None
Update the text sprite.
| Returns: |
|
|---|
add(*groups: LayeredDirty) -> None
Add the sprite to a group.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, focus: object) -> None
Handle mouse focus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle mouse unfocus events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: BitmappySprite
A button sprite class.
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
instance-attribute
border_color = (255, 255, 255)
instance-attribute
active_color = (128, 128, 128)
instance-attribute
inactive_color = (0, 0, 0)
instance-attribute
background_color = inactive_color
instance-attribute
text = TextSprite(
background_color=background_color,
x=centerx if parent else x,
y=centery if parent else y,
width=width,
height=height,
text=name,
parent=self,
groups=groups,
)
property
writable
x: int
Get the x coordinate of the button sprite.
| Returns: |
|
|---|
property
writable
y: int
Get the y coordinate of the button sprite.
| Returns: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
parent: object | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize a ButtonSprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update_nested_sprites() -> None
Update the nested sprites.
Sets the dirty flag on the nested sprites.
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: ButtonSprite
A checkbox sprite class.
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
instance-attribute
border_color = (255, 255, 255)
instance-attribute
active_color = (128, 128, 128)
instance-attribute
inactive_color = (0, 0, 0)
instance-attribute
background_color = inactive_color
instance-attribute
text = TextSprite(
background_color=background_color,
x=centerx if parent else x,
y=centery if parent else y,
width=width,
height=height,
text=name,
parent=self,
groups=groups,
)
property
writable
x: int
Get the x coordinate of the button sprite.
| Returns: |
|
|---|
property
writable
y: int
Get the y coordinate of the button sprite.
| Returns: |
|
|---|
instance-attribute
checked = False
instance-attribute
color = (128, 128, 128)
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
update_nested_sprites() -> None
Update the nested sprites.
Sets the dirty flag on the nested sprites.
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
callbacks: Callable | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize a CheckboxSprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the checkbox sprite.
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: Sprite
An input box class.
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [self]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
property
writable
width: int
Return the width of the sprite.
| Returns: |
|
|---|
property
writable
height: int
Return the height of the sprite.
| Returns: |
|
|---|
instance-attribute
offset_x = x if parent else 0
instance-attribute
offset_y = y if parent else 0
instance-attribute
rect = Rect(x, y, width, height)
instance-attribute
font = SysFont('Times', 14)
instance-attribute
text_image = render(text, True, color)
instance-attribute
active = False
instance-attribute
image = Surface((width, height))
instance-attribute
cursor_rect = get_rect()
instance-attribute
cursor = Rect(topright, (3, height))
instance-attribute
dirty = 2
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
__init__(
x: int,
y: int,
width: int,
height: int,
color: tuple = (233, 248, 215),
text: str = "",
name: str | None = None,
parent: object | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize an InputBox.
| Parameters: |
|
|---|
| Returns: |
|
|---|
activate() -> None
Activate the input box.
| Returns: |
|
|---|
deactivate() -> None
Deactivate the input box.
| Returns: |
|
|---|
on_input_box_submit_event(event: Event) -> None
Handle input box submit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the input box.
| Returns: |
|
|---|
render() -> None
Render the input box.
| Returns: |
|
|---|
on_mouse_up_event(event: Event) -> None
Handle mouse up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle key up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle key down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: BitmappySprite
A text box sprite class.
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
instance-attribute
value = None
instance-attribute
background_color = (0, 0, 0)
instance-attribute
border_width = 1
instance-attribute
text_box = TextSprite(
background_color=background_color,
x=x,
y=y,
width=width - border_width,
height=height - border_width,
text=value,
parent=self,
groups=groups,
)
instance-attribute
proxies = [parent]
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
callbacks: Callable | None = None,
parent: object | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize a TextBoxSprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update_nested_sprites() -> None
Update the nested sprites.
| Returns: |
|
|---|
update() -> None
Update the text box sprite.
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle left mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: BitmappySprite
A slider sprite class.
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
instance-attribute
text_sprite = TextSprite(
x=257, y=y, width=40, height=16, name=str((0, 0, 0)), parent=self, groups=groups
)
instance-attribute
slider_knob = SliderKnobSprite(
x=x,
y=y - 1,
width=height * 2 - 1,
height=height * 2 - 1,
name=name,
parent=self,
groups=groups,
)
instance-attribute
image = Surface((width, height))
instance-attribute
rect = get_rect()
instance-attribute
background = Surface((width, height))
property
writable
value: int
Get the value of the slider sprite.
| Returns: |
|
|---|
property
writable
x: int
Get the x coordinate of the slider sprite.
| Returns: |
|
|---|
property
writable
y: int
Get the y coordinate of the slider sprite.
| Returns: |
|
|---|
Bases: BitmappySprite
A slider knob sprite class.
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
instance-attribute
value = 0
instance-attribute
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update() -> None
Update the sprite.
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
parent: object | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize a SliderKnobSprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
parent: object | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize a SliderSprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update_nested_sprites() -> None
Update the nested sprites.
| Returns: |
|
|---|
update() -> None
Update the slider sprite.
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle left mouse button down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object) -> None
Handle left mouse drag events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Bases: BitmappySprite
A color well sprite class.
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
width = width
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
instance-attribute
red = 0
instance-attribute
green = 0
instance-attribute
blue = 0
instance-attribute
text_sprite = TextBoxSprite(
x=midleft[0] + width,
y=centery - 10,
width=100,
height=20,
name=str(active_color),
parent=self,
groups=groups,
)
property
writable
active_color: tuple[int, int, int]
Get the active color.
| Returns: |
|
|---|
property
hex_color: str
Get the hex color.
| Returns: |
|
|---|
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle a mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle a key down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle a key up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str,
parent: object | None = None,
groups: LayeredDirty | None = None,
) -> None
Initialize a ColorWellSprite.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update_nested_sprites() -> None
Update the nested sprites.
| Returns: |
|
|---|
update() -> None
Update the color well sprite.
| Returns: |
|
|---|
Bases: BitmappySprite
An input dialog class.
instance-attribute
rect = get_rect()
instance-attribute
image = Surface((width, height))
class-attribute
instance-attribute
USE_GFXDRAW: ClassVar = False
class-attribute
instance-attribute
PROXIES: ClassVar = [sprite]
class-attribute
instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
class-attribute
instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
class-attribute
instance-attribute
SPRITE_COUNT = 0
instance-attribute
dt = 0
instance-attribute
dt_timer = 0
instance-attribute
proxies = [parent]
instance-attribute
callbacks = {}
instance-attribute
screen = get_surface()
instance-attribute
screen_width = get_width()
instance-attribute
screen_height = get_height()
instance-attribute
height = height
class-attribute
instance-attribute
DEBUG = False
class-attribute
instance-attribute
DEFAULT_SURFACE_W = 42
class-attribute
instance-attribute
DEFAULT_SURFACE_H = 42
class-attribute
instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
instance-attribute
background_color = (0, 0, 0)
instance-attribute
border_width = 1
instance-attribute
dialog_text_sprite = TextBoxSprite(
name=dialog_text, x=x, y=y, width=width // 2, height=20, parent=self, groups=groups
)
instance-attribute
confirm_button = ButtonSprite(name=confirm_text, x=x, y=y, width=75, height=20, groups=groups)
instance-attribute
cancel_button = ButtonSprite(name=cancel_text, x=x, y=y, width=75, height=20, groups=groups)
instance-attribute
input_box = InputBox(
x=x + width // 2, y=y + height // 2, width=200, height=20, text="", parent=self, groups=groups
)
classmethod
__subclasshook__(subclass: object) -> bool
Override the default subclasshook to create an interface.
on_mouse_motion_event(event: Event) -> None
Handle a mouse motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a left mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None
Handle a right mouse drop event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_focus_event(event: Event, old_focus: object) -> None
Handle a mouse focus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_unfocus_event(event: Event) -> None
Handle a mouse unfocus event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_up_event(event: Event) -> None
Handle a left mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_up_event(event: Event) -> None
Handle a middle mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_up_event(event: Event) -> None
Handle a right mouse button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_down_event(event: Event) -> None
Handle a mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_button_down_event(event: Event) -> None
Handle a left mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_button_down_event(event: Event) -> None
Handle a middle mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_button_down_event(event: Event) -> None
Handle a right mouse button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_down_event(event: Event) -> None
Handle a mouse scroll down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_scroll_up_event(event: Event) -> None
Handle a mouse scroll up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_wheel_event(event: Event, trigger: object | None) -> None
Handle a mouse wheel event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
classmethod
break_when(sprite_type: object | None = None) -> None
Register a breakpoint for a sprite type.
| Parameters: |
|
|---|
| Returns: |
|
|---|
dt_tick(dt: float) -> None
Update the sprite's delta time.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_axis_motion_event(event: Event) -> None
Handle a joystick axis motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_down_event(event: Event) -> None
Handle a joystick button down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_button_up_event(event: Event) -> None
Handle a joystick button up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_hat_motion_event(event: Event) -> None
Handle a joystick hat motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_joy_ball_motion_event(event: Event) -> None
Handle a joystick ball motion event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_enter_event(event: Event) -> None
Handle a mouse enter event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_exit_event(event: Event) -> None
Handle a mouse exit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a left mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a middle mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag down event.
Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.
| Returns: |
|
|---|
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None
Handle a right mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_drag_up_event(event: Event) -> None
Handle a mouse drag up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_up_event(event: Event, keys: list) -> None
Handle a mouse chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_chord_down_event(event: Event, keys: list) -> None
Handle a mouse chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_down_event(event: Event, keys: list) -> None
Handle a key chord down event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_chord_up_event(event: Event, keys: list) -> None
Handle a key chord up event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_quit_event(event: Event) -> None
Handle a quit event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_active_event(event: Event) -> None
Handle an active event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_resize_event(event: Event) -> None
Handle a video resize event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_video_expose_event(event: Event) -> None
Handle a video expose event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_sys_wm_event(event: Event) -> None
Handle a sys wm event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_user_event(event: Event) -> None
Handle a user event.
| Parameters: |
|
|---|
| Returns: |
|
|---|
__str__() -> str
Returns a string representation of the sprite.
load(filename: str) -> tuple[Surface, Rect, str]
Load a sprite from a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]
Inflate a sprite from a list of pixels.
| Parameters: |
|
|---|
| Returns: |
|
|---|
save(filename: str) -> None
Save a sprite to a Bitmappy config file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
deflate() -> dict
Deflate a sprite to a Bitmappy config file.
| Returns: |
|
|---|
__init__(
x: int,
y: int,
width: int,
height: int,
name: str | None = None,
dialog_text: str = "Would you like to do a thing?",
confirm_text: str = "Confirm",
cancel_text: str = "Cancel",
callbacks: Callable | None = None,
parent: object = None,
groups: LayeredDirty | None = None,
) -> None
Initialize an InputDialog.
| Parameters: |
|
|---|
| Returns: |
|
|---|
update_nested_sprites() -> None
Update the nested sprites.
| Returns: |
|
|---|
update() -> None
Update the input dialog.
| Returns: |
|
|---|
on_confirm_event(event: Event, trigger: object) -> None
Handle confirm events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_cancel_event(event: Event, trigger: object) -> None
Handle cancel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_input_box_cancel_event(control: object) -> None
Handle input box cancel events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_input_box_submit_event(event: Event) -> None
Handle input box submit events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_mouse_button_up_event(event: Event) -> None
Handle mouse button up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_up_event(event: Event) -> None
Handle key up events.
| Parameters: |
|
|---|
| Returns: |
|
|---|
on_key_down_event(event: Event) -> None
Handle key down events.
| Parameters: |
|
|---|
| Returns: |
|
|---|